Add a deprecated_member() function to fix typing
#98
Conversation
llucax
requested review from
Marenz and
Copilot
and removed request for
Copilot
github-actions
bot
added
part:docs
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new deprecated_member() function to improve typing when creating deprecated enum members. The function provides a type-safe wrapper around the existing DeprecatedMember class.
- Adds a generic
deprecated_member()function that returns the correct type for mypy - Updates all existing usage of
DeprecatedMemberto use the new function - Updates documentation and examples to reflect the new preferred approach
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/frequenz/core/enum.py | Adds the new deprecated_member() function and updates documentation |
| tests/test_enum.py | Updates tests to use new function and adds comprehensive test coverage |
| README.md | Updates example to demonstrate the new function usage |
| RELEASE_NOTES.md | Documents the new feature and upgrade guidance |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
llucax
force-pushed
the
deprecated-type-fix
branch
from
1d48054 to
5345a23
Compare
| """ | ||
| return cast(ValueT, DeprecatedMember(value, message)) | ||
|
|
||
|
|
There was a problem hiding this comment.
So will you deprecate direct usage of DeprecatedMember then? 😆
There was a problem hiding this comment.
I thought about it. But I think it is too meta 😆
But when we go for 2.0.0 I think I would make it private, we really don't need to expose it at all.
There was a problem hiding this comment.
Ahhh, so nice to have gotten issue number 100 for:
When using the `DeprecatedMember` class directly, `mypy` will struggle because it will think the actual type of the value is `DeprecatedMember` instead of the real underlying value. To fix this we create a simple generic wrapper that will cast the `DeprecatedMember` to the type of the value. Signed-off-by: Leandro Lucarella <[email protected]>
Signed-off-by: Leandro Lucarella <[email protected]>
llucax
force-pushed
the
deprecated-type-fix
branch
from
5345a23 to
9830fad
Compare
|
Updated. |
3 participants
When using the
DeprecatedMemberclass directly,mypywill struggle because it will think the actual type of the value isDeprecatedMemberinstead of the real underlying value.To fix this we create a simple generic wrapper
deprecated_member()that will cast theDeprecatedMemberto the type of the value.